1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: TunnelHelper.java,v 1.2 2005/04/08 15:16:46 tanderson Exp $
44 */
45 package org.exolab.jms.net.http;
46
47 import java.io.IOException;
48 import java.net.HttpURLConnection;
49 import java.net.URL;
50
51 import org.apache.commons.codec.binary.Base64;
52
53
54 /***
55 * Helper class for establishing connections to the tunnel servlet.
56 *
57 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58 * @version $Revision: 1.2 $ $Date: 2005/04/08 15:16:46 $
59 */
60 class TunnelHelper {
61
62 /***
63 * Create an {@link HttpURLConnection} to the tunnel servlet.
64 * <p/>
65 * If the supplied connection request info contains a proxy user and
66 * password, these will be encoded and passed in the "Proxy-Authorization"
67 * request property.
68 *
69 * @param url the tunnel servlet URL
70 * @param id the connection identifier. May be <code>null</code>.
71 * @param action the action to perform
72 * @param info the connection request info.
73 */
74 public static HttpURLConnection create(URL url, String id, String action,
75 HTTPRequestInfo info)
76 throws IOException {
77 HttpURLConnection connection =
78 (HttpURLConnection) url.openConnection();
79 connection.setRequestMethod("POST");
80 if (id != null) {
81 connection.setRequestProperty("id", id);
82 }
83 connection.setRequestProperty("action", action);
84 connection.setUseCaches(false);
85 if (info.getProxyUser() != null && info.getProxyPassword() != null) {
86 String pwd = info.getProxyUser() + ":" + info.getProxyPassword();
87 String encoded = new String(Base64.encodeBase64(pwd.getBytes()));
88 connection.setRequestProperty("Proxy-Authorization",
89 "Basic " + encoded);
90 }
91 return connection;
92 }
93
94 /***
95 * Create an {@link HttpURLConnection} to the tunnel servlet, and connect
96 * to it.
97 * <p/>
98 * If the supplied connection request info contains a proxy user and
99 * password, these will be encoded and passed in the "Proxy-Authorization"
100 * header.
101 *
102 * @param url the tunnel servlet URL
103 * @param id the connection identifier. May be <code>null</code>.
104 * @param action the action to perform
105 * @param info the connection request info.
106 * @throws IOException if an I/O error occurs
107 */
108 public static HttpURLConnection connect(URL url, String id, String action,
109 HTTPRequestInfo info)
110 throws IOException {
111
112 HttpURLConnection connection = create(url, id, action, info);
113 connection.setRequestProperty("Content-Length", "0");
114 connection.connect();
115 if (connection.getResponseCode() != HttpURLConnection.HTTP_OK) {
116 throw new IOException(connection.getResponseCode() + " "
117 + connection.getResponseMessage());
118 }
119 return connection;
120 }
121 }